Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Docs] Add vizro-ai chart examples to docs #469

Merged
merged 16 commits into from
May 13, 2024
Merged

[Docs] Add vizro-ai chart examples to docs #469

merged 16 commits into from
May 13, 2024
+148 −3

Conversation

nadijagraca
Copy link
Contributor

Description

Added examples section with one page(chart examples)

Notice

  • I acknowledge and agree that, by checking this box and clicking "Submit Pull Request":

    • I submit this contribution under the Apache 2.0 license and represent that I am entitled to do so on behalf of myself, my employer, or relevant third parties, as applicable.
    • I certify that (a) this contribution is my original creation and / or (b) to the extent it is not my original creation, I am authorized to submit this contribution on behalf of the original creator(s) or their licensees.
    • I certify that the use of this contribution as authorized by the Apache 2.0 license does not violate the intellectual property rights of anyone else.
    • I have not referenced individuals, products or companies in any commits, directly or indirectly.
    • I have not added data or restricted code in any commits, directly or indirectly.

@nadijagraca nadijagraca temporarily deployed to vizro_ai_secrets May 9, 2024 15:16 — with GitHub Actions Inactive
@nadijagraca nadijagraca temporarily deployed to vizro_ai_secrets May 9, 2024 15:16 — with GitHub Actions Inactive
@nadijagraca nadijagraca temporarily deployed to vizro_ai_secrets May 9, 2024 15:16 — with GitHub Actions Inactive
@nadijagraca nadijagraca temporarily deployed to vizro_ai_secrets May 9, 2024 15:16 — with GitHub Actions Inactive
@nadijagraca nadijagraca temporarily deployed to vizro_ai_secrets May 9, 2024 15:16 — with GitHub Actions Inactive
huong-li-nguyen
huong-li-nguyen reviewed May 9, 2024
View reviewed changes
Copy link
Contributor

@huong-li-nguyen huong-li-nguyen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for creating these! Have a few suggestions on rephrasing :)

vizro-ai/docs/pages/user-guides/chart-examples.md Outdated Show resolved Hide resolved
vizro-ai/docs/pages/user-guides/chart-examples.md Outdated Show resolved Hide resolved
vizro-ai/docs/pages/user-guides/chart-examples.md Outdated Show resolved Hide resolved
vizro-ai/docs/pages/user-guides/chart-examples.md Outdated Show resolved Hide resolved
vizro-ai/docs/pages/user-guides/chart-examples.md Outdated Show resolved Hide resolved
vizro-ai/docs/pages/user-guides/chart-examples.md Outdated Show resolved Hide resolved
vizro-ai/docs/pages/user-guides/chart-examples.md Outdated Show resolved Hide resolved
stichbury
stichbury reviewed May 9, 2024
View reviewed changes
Copy link
Contributor

@stichbury stichbury left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably needs these few changes and I'm happy to pick it up tomorrow (Friday) and make edits direct on the branch once you've worked through anything you want to do from these suggestions.

@nadijagraca nadijagraca temporarily deployed to vizro_ai_secrets May 9, 2024 16:47 — with GitHub Actions Inactive
@nadijagraca nadijagraca temporarily deployed to vizro_ai_secrets May 9, 2024 16:47 — with GitHub Actions Inactive
@nadijagraca nadijagraca temporarily deployed to vizro_ai_secrets May 9, 2024 16:47 — with GitHub Actions Inactive
@stichbury stichbury temporarily deployed to vizro_ai_secrets May 10, 2024 09:26 — with GitHub Actions Inactive
@stichbury stichbury temporarily deployed to vizro_ai_secrets May 10, 2024 09:26 — with GitHub Actions Inactive
stichbury
stichbury approved these changes May 10, 2024
View reviewed changes
Copy link
Contributor

@stichbury stichbury left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All looks good to me, thank you @nadijagraca! I made two commits, one to this page for a couple of minor things. And one bug fix -- there was a broken link reported by docs:serve so I fixed it here. Ready to go from my perspective -- the graphics look fine.

maxschulz-COL
maxschulz-COL approved these changes May 10, 2024
View reviewed changes
Copy link
Contributor

@maxschulz-COL maxschulz-COL left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! My suggestions are very optional, leave it up to you two @nadijagraca and @stichbury what you make of it.

If we go with this approach, I would actually for once change the order of result and code, because it's much nice browsing a gallery if the images are immediately visible. The code here really is secondary!

vizro-ai/mkdocs.yml Show resolved Hide resolved
vizro-ai/docs/pages/user-guides/chart-examples.md Outdated Show resolved Hide resolved
vizro-ai/docs/pages/user-guides/chart-examples.md Outdated Show resolved Hide resolved
vizro-ai/docs/pages/user-guides/chart-examples.md Outdated Show resolved Hide resolved
vizro-ai/docs/pages/user-guides/chart-examples.md Outdated Show resolved Hide resolved
vizro-ai/docs/pages/user-guides/chart-examples.md Outdated Show resolved Hide resolved
@nadijagraca nadijagraca temporarily deployed to vizro_ai_secrets May 10, 2024 11:46 — with GitHub Actions Inactive
@nadijagraca nadijagraca temporarily deployed to vizro_ai_secrets May 10, 2024 11:46 — with GitHub Actions Inactive
@nadijagraca nadijagraca temporarily deployed to vizro_ai_secrets May 10, 2024 11:46 — with GitHub Actions Inactive
@nadijagraca nadijagraca temporarily deployed to vizro_ai_secrets May 10, 2024 11:46 — with GitHub Actions Inactive
@nadijagraca nadijagraca temporarily deployed to vizro_ai_secrets May 10, 2024 11:46 — with GitHub Actions Inactive
@stichbury
Copy link
Contributor

Agree with the suggestion to bring the graphic to the front in this case!

@nadijagraca nadijagraca temporarily deployed to vizro_ai_secrets May 13, 2024 09:33 — with GitHub Actions Inactive
@nadijagraca nadijagraca temporarily deployed to vizro_ai_secrets May 13, 2024 09:33 — with GitHub Actions Inactive
@nadijagraca nadijagraca temporarily deployed to vizro_ai_secrets May 13, 2024 09:33 — with GitHub Actions Inactive
@nadijagraca nadijagraca temporarily deployed to vizro_ai_secrets May 13, 2024 09:33 — with GitHub Actions Inactive
@nadijagraca nadijagraca temporarily deployed to vizro_ai_secrets May 13, 2024 09:33 — with GitHub Actions Inactive
@nadijagraca nadijagraca temporarily deployed to vizro_ai_secrets May 13, 2024 13:27 — with GitHub Actions Inactive
@nadijagraca nadijagraca temporarily deployed to vizro_ai_secrets May 13, 2024 13:27 — with GitHub Actions Inactive
@nadijagraca nadijagraca temporarily deployed to vizro_ai_secrets May 13, 2024 13:27 — with GitHub Actions Inactive
@nadijagraca nadijagraca temporarily deployed to vizro_ai_secrets May 13, 2024 13:27 — with GitHub Actions Inactive
@nadijagraca nadijagraca temporarily deployed to vizro_ai_secrets May 13, 2024 13:27 — with GitHub Actions Inactive
@nadijagraca nadijagraca temporarily deployed to vizro_ai_secrets May 13, 2024 14:43 — with GitHub Actions Inactive
@nadijagraca nadijagraca temporarily deployed to vizro_ai_secrets May 13, 2024 14:43 — with GitHub Actions Inactive
@nadijagraca nadijagraca temporarily deployed to vizro_ai_secrets May 13, 2024 14:43 — with GitHub Actions Inactive
@nadijagraca nadijagraca temporarily deployed to vizro_ai_secrets May 13, 2024 14:43 — with GitHub Actions Inactive
@nadijagraca nadijagraca temporarily deployed to vizro_ai_secrets May 13, 2024 14:43 — with GitHub Actions Inactive
@nadijagraca nadijagraca merged commit e135370 into main May 13, 2024
39 checks passed
@nadijagraca nadijagraca deleted the docs/vizro-ai_add_chart_examples branch May 13, 2024 15:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@huong-li-nguyen huong-li-nguyen huong-li-nguyen left review comments

@stichbury stichbury stichbury approved these changes

@maxschulz-COL maxschulz-COL maxschulz-COL approved these changes

@Joseph-Perkins Joseph-Perkins Awaiting requested review from Joseph-Perkins Joseph-Perkins is a code owner

@antonymilne antonymilne Awaiting requested review from antonymilne antonymilne is a code owner

@Anna-Xiong Anna-Xiong Awaiting requested review from Anna-Xiong

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@nadijagraca @stichbury @maxschulz-COL @huong-li-nguyen